﻿//-----------------------------------------------------------------------
// <copyright file="ISetupService.cs" company="OOHM PROCESSAMENTO DE DADOS LTDA.">
//     Microsoft Public License (MS-PL) This license governs use of the accompanying
//     software. If you use the software, you accept this license. If you do not
//     accept the license, do not use the software. 1. Definitions The terms "reproduce,"
//     "reproduction," "derivative works," and "distribution" have the same meaning
//     here as under U.S. copyright law. A "contribution" is the original software,
//     or any additions or changes to the software. A "contributor" is any person
//     that distributes its contribution under this license. "Licensed patents"
//     are a contributor's patent claims that read directly on its contribution.
//     2. Grant of Rights (A) Copyright Grant- Subject to the terms of this license,
//     including the license conditions and limitations in section 3, each contributor
//     grants you a non-exclusive, worldwide, royalty-free copyright license to
//     reproduce its contribution, prepare derivative works of its contribution,
//     and distribute its contribution or any derivative works that you create.
//     (B) Patent Grant- Subject to the terms of this license, including the license
//     conditions and limitations in section 3, each contributor grants you a non-exclusive,
//     worldwide, royalty-free license under its licensed patents to make, have
//     made, use, sell, offer for sale, import, and/or otherwise dispose of its
//     contribution in the software or derivative works of the contribution in
//     the software. 3. Conditions and Limitations (A) No Trademark License- This
//     license does not grant you rights to use any contributors' name, logo, or
//     trademarks. (B) If you bring a patent claim against any contributor over
//     patents that you claim are infringed by the software, your patent license
//     from such contributor to the software ends automatically. (C) If you distribute
//     any portion of the software, you must retain all copyright, patent, trademark,
//     and attribution notices that are present in the software. (D) If you distribute
//     any portion of the software in source code form, you may do so only under
//     this license by including a complete copy of this license with your distribution.
//     If you distribute any portion of the software in compiled or object code
//     form, you may only do so under a license that complies with this license.
//     (E) The software is licensed "as-is." You bear the risk of using it. The
//     contributors give no express warranties, guarantees or conditions. You may
//     have additional consumer rights under your local laws which this license
//     cannot change. To the extent permitted under your local laws, the contributors
//     exclude the implied warranties of merchantability, fitness for a particular
// </copyright>
//-----------------------------------------------------------------------
namespace AbstractSaaSTemplate.Domain.Services{    using AbstractSaaSTemplate.Domain.Services.Results;

    /// <summary>
    /// Describes the contract for the 'Setup' service.
    /// </summary>
    public interface ISetupService : IService
    {
        /// <summary>
        /// Runs the installation procedures for the software.
        /// </summary>
        /// <param name="encryptionParaphrase">The paraphrase used to generated the encryption key.</param>
        /// <param name="staffAdministratorEmail">The e-mail linked to the administrator of the staff, which will receive the administrator password.</param>
        /// <param name="connectionString">The connection string for the database.</param>
        /// <param name="blobsRootPath">The blobs root folder.</param>
        /// <param name="blobsBaseLocation">The base url for blobs.</param>
        /// <param name="smtpHost">The smtp host which will be setup to the system.</param>
        /// <param name="smtpPort">The port of the smtp server.</param>
        /// <param name="smtpLogin">The login for the smtp server.</param>
        /// <param name="smtpPassword">The password for the smtp server.</param>
        /// <param name="smtpRequiresSsl">The value indicating whether the smtp server requires SSL.</param>
        /// <param name="emailDefaultSenderName">The name for the system default e-mail sender.</param>
        /// <param name="emailDefaultSenderEmailAddress">The e-mail address for the system default e-mail sender.</param>
        /// <param name="baseAppDomain">The base domain in which the application will be used.</param>
        /// <returns>Returns the installation results.</returns>
        SetupInstallationResult RunInstall(
            string encryptionParaphrase,
            string staffAdministratorEmail,
            string connectionString,
            string blobsRootPath,
            string blobsBaseLocation,
            string smtpHost,
            int smtpPort,
            string smtpLogin,
            string smtpPassword,
            bool smtpRequiresSsl,
            string emailDefaultSenderName,
            string emailDefaultSenderEmailAddress,
            string baseAppDomain);
    }
}


